-
Notifications
You must be signed in to change notification settings - Fork 229
DOC: Technical Reference: Add table for text formatting #3976
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
A new ruff version (0.12.0) was released a few hours ago (https://pypi.org/project/ruff/) leading to several (~20) failing Style checks (https://github.com/GenericMappingTools/pygmt/actions/runs/15714747994/job/44281566411?pr=3976). |
Yes, addressed in #3980. |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Perhaps we should also update https://www.pygmt.org/dev/tutorials/basics/text.html, maybe in a separate PR? |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Good point! Adding a section to this tutorial sounds good to me, or do we just want to add a link to this Technical Reference page? |
Maybe a separate tutorial or gallery example is better? |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Looks good. Could you please rewrap the short lines to 88 characters then it should be good to merge |
Description of proposed changes
Following https://docs.generic-mapping-tools.org/dev/text.html#description, this PR addes a table to the Technical References for formatting text.
Preview: https://pygmt-dev--3976.org.readthedocs.build/en/3976/techref/text_formatting.html
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code